Customer Management Biz Api

(0 reviews)

CR GET Customer

GET (TMF-629)

This operation allows for the listing of Customer entities with operations that enable users to retrieve the customers with operation GET from the system and apply the transformations if required to maintain the standards with TMF.

URL

For ONPREM:

http://[localhost]:[port]tmf-api/customerManagement/v1/{businessId}/customer

For cloudhub:

https://esb-cloud-dev.lla.com/dev/customer-management-biz/tmf-api/customerManagement/v4/BS/customer

Base URI Parameter

Name	Type	M/O	Description
businessId	string	M	Business unit identifier. Example: “JM”,“PA”,“PR”,“CR”

Headers

name	value	description	required
X-Correlation-ID	string	This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers. Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b	O
channeId	string	Channel to business: Expected Value: "ECOM"	O M for cloudhub usecase
lob	String	Enum: PREPAID, POSTPAID,FIXED	O
targetSystem	string	To identify the targetSystem Example : "emarsys"	M for cloudhub usecase

Security Headers

name	value	description	required
client_id	string	Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg:6f0ed16a7b494d76b2d60e05bc3b3332	M
client_secret	string	Client secret value for Client Id Enforcement policy. Environment Specific Value Eg: e4CD4D43449846aA9D8Cb9c43fAd324a	M

Query Param

name	type	description	required
characteristic.identityType	enum	identityType defines the idProof of customer. Possible Values [C, PP, CR, CF]	O
characteristic.identityCode	string	identityCode defines the value of the identityType CEDULA JURIDICA and INSTITUCIONES AUTÓNOMAS are applicable for B2B. There are some rules depending on the identification type: Possible Values: - CEDULA FISICA Validation Rule: /^(\0[1-9])(\d{4})(\d{4})$/g /^\0[1-9]-\d{4}-\d{4}\$/g; - PASAPORTE Validation Rule: /^([A-Za-z0-9]{8,10}?)\$/g /^([A-Za-z0-9]{8,10}?)\$/g - CEDULA RESIDENCIA Validation Rule: IF the field "amnistia" has the value "Y" /^(\d{1})(\d{3})(RE\d{6})\$/g /^(\d{1})-(\d{3})-(RE\d{6})\$/g ELSE IF the field "amnistia" has the value “N” /^(\d{1})(\d{3})(\d{8})\$/g /^(\d{1})-(\d{3})-(\d{8})\$/g Example { "characteristic.identityType":"CF", "characteristic.identityCode":"01-4498-5920" }	O
characteristic.key	string	Example firstName,lastName,lastName2,id	O
characteristic.value	string	Example ALVARADO,VILLALTA,GILBERTO,1-2F7GQHX	O
contactMedium.characteristic.emailAddress[]	array	Example : "["shiva-shankar.t@capgemini.com"]"	M for cloudhub usecase

HTTP Status response is 200

Response Sample for CR Fixed.

[
    {
        "id": "1-2DWU2NH",
        "name": "JORGE STEVEN GOÑI SEGURA",
        "status": "Active",
        "contactMedium": [
            {
                "mediumType": "Address",
                "characteristic": {
                    "street1": "CALLE DEL COUNTRY",
                    "street2": "ESCAZU",
                    "stateOrProvince": "SAN JOSE",
                    "city": "ESCAZU"
                  }
            },
            {
                "mediumType": "Email",
                "characteristic": {
                    "phoneNumber": "test@lla.com",
                    "contactType": "email"
                }
            },
            {
                "mediumType": "Telephone",
                "characteristic": {
                    "phoneNumber": "+50688777575",
                    "contactType": "home"
                }
            },
            {
                "mediumType": "Telephone",
                "characteristic": {
                    "phoneNumber": "+50688777576",
                     "contactType": "mobile"
                }
            }
        ],
        "characteristic": [
            {
                "name": "idProof",
                "value": "01-4498-5920"
            },
            {
                "name": "idProofType",
                "value": "CEDULA FISICA"
            },
            {
                "name": "addressId",
                "value": "1-2F741ZW"
            },
            {
                "name": "contactId",
                "value": "1-2F741ZY"
            },
            {
                "name": "settlementAccountId",
                "value": "1-2F741ZW"
            },
            {
             "name": "district",
             "value": "PUNTARENAS"
            },
            {
              "name": "customerType",
              "value": "RESIDENCIAL"
            }

        ]
    }
]

Sample Response for emarsys get contact:

[
    {
        "id": "104995227",
        "contactMedium": [
            {
                "characteristic": {
                    "emailAddress": "shiva-shankar.t@capgemini.com"
                }
            }
        ]
    }
]